Security News
Internet Archive Hacked, 31 Million Record Compromised
The Internet Archive's "Wayback Machine" has been hacked and defaced, with 31 millions records compromised.
eslint-template-visitor
Advanced tools
[![Build Status](https://travis-ci.org/futpib/eslint-template-visitor.svg?branch=master)](https://travis-ci.org/futpib/eslint-template-visitor) [![Coverage Status](https://coveralls.io/repos/github/futpib/eslint-template-visitor/badge.svg?branch=master)](
Simplify eslint rules by visiting templates
npm install eslint-template-visitor
# or
yarn add eslint-template-visitor
+const eslintTemplateVisitor = require('eslint-template-visitor');
+
+const templates = eslintTemplateVisitor();
+
+const objectVariable = templates.variable();
+const argumentsVariable = templates.spreadVariable();
+
+const substrCallTemplate = templates.template`${objectVariable}.substr(${argumentsVariable})`;
const create = context => {
const sourceCode = context.getSourceCode();
- return {
- CallExpression(node) {
- if (node.callee.type !== 'MemberExpression'
- || node.callee.property.type !== 'Identifier'
- || node.callee.property.name !== 'substr'
- ) {
- return;
- }
-
- const objectNode = node.callee.object;
+ return templates.visitor({
+ [substrCallTemplate](node) {
+ const objectNode = substrCallTemplate.context.getMatch(objectVariable);
+ const argumentNodes = substrCallTemplate.context.getMatch(argumentsVariable);
const problem = {
node,
message: 'Prefer `String#slice()` over `String#substr()`.',
};
- const canFix = node.arguments.length === 0;
+ const canFix = argumentNodes.length === 0;
if (canFix) {
problem.fix = fixer => fixer.replaceText(node, sourceCode.getText(objectNode) + '.slice()');
}
context.report(problem);
},
- };
+ });
};
See examples for more.
eslintTemplateVisitor(options?)
Craete a template visitor.
Example:
const eslintTemplateVisitor = require('eslint-template-visitor');
const templates = eslintTemplateVisitor();
options
Type: object
parserOptions
Options for the template parser. Passed down to espree
.
Example:
const templates = eslintTemplateVisitor({
parserOptions: {
ecmaVersion: 2018,
},
});
templates.variable()
Create a variable to be used in a template. Such a variable can match exactly one AST node.
templates.spreadVariable()
Create a spread variable. Spread variable can match an array of AST nodes.
This is useful for matching a number of arguments in a call or a number of statements in a block.
templates.template
tagCreates a template possibly containing variables.
Example:
const objectVariable = templates.variable();
const argumentsVariable = templates.spreadVariable();
const substrCallTemplate = templates.template`${objectVariable}.substr(${argumentsVariable})`;
const create = () => templates.visitor({
[substrCallTemplate](node) {
// `node` here is the matching `.substr` call (i.e. `CallExpression`)
}
});
templates.visitor({ /* visitors */ })
Used to merge template visitors with common ESLint visitors.
Example:
const create = () => templates.visitor({
[substrCallTemplate](node) {
// Template visitor
},
FunctionDeclaration(node) {
// Simple node type visitor
},
'IfStatement > BlockStatement'(node) {
// ESLint selector visitor
},
});
template.context
A template match context. This property is defined only within a visitor call (in other words, only when working on a matching node).
Example:
const create = () => templates.visitor({
[substrCallTemplate](node) {
// `substrCallTemplate.context` can be used here
},
FunctionDeclaration(node) {
// `substrCallTemplate.context` is not defined here, and it does not make sense to use it here,
// since we `substrCallTemplate` did not match an AST node.
},
});
template.context.getMatch(variable)
Used to get a match for a variable.
Example:
const objectVariable = templates.variable();
const argumentsVariable = templates.spreadVariable();
const substrCallTemplate = templates.template`${objectVariable}.substr(${argumentsVariable})`;
const create = () => templates.visitor({
[substrCallTemplate](node) {
const objectNode = substrCallTemplate.context.getMatch(objectVariable);
// For example, let's check if `objectNode` is an `Identifier`: `objectNode.type === 'Identifier'`
const argumentNodes = substrCallTemplate.context.getMatch(argumentsVariable);
// `Array.isArray(argumentNodes) === true`
},
});
FAQs
[![Build Status](https://travis-ci.org/futpib/eslint-template-visitor.svg?branch=master)](https://travis-ci.org/futpib/eslint-template-visitor) [![Coverage Status](https://coveralls.io/repos/github/futpib/eslint-template-visitor/badge.svg?branch=master)](
The npm package eslint-template-visitor receives a total of 211,073 weekly downloads. As such, eslint-template-visitor popularity was classified as popular.
We found that eslint-template-visitor demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The Internet Archive's "Wayback Machine" has been hacked and defaced, with 31 millions records compromised.
Security News
TC39 is meeting in Tokyo this week and they have approved nearly a dozen proposals to advance to the next stages.
Security News
Our threat research team breaks down two malicious npm packages designed to exploit developer trust, steal your data, and destroy data on your machine.